home *** CD-ROM | disk | FTP | other *** search
/ Archive Magazine CD 1995 / Archive Magazine CD 1995.iso / discs / prog_disc / volume_5 / issue_05 / extras / arcscan / readme
Encoding:
Text File  |  1992-01-06  |  7.7 KB  |  177 lines
  1. ARCHIVE Magazine Index Data for ARCSCAN II or III Filing Systems
  2. ================================================================
  3. [C] E.W.Ayers : Jan 1992            update to 6.1.92
  4.  
  5. ARCSCAN is a trademark of BEEBUG Ltd.
  6.  
  7.                          NOTE - ARCSCANIII
  8.  
  9. BeeBug's most recent version - ArcScanIII - is fully multi-tasking. It is
  10. fully compatible with ArcScanII, and the ARCHIVE ArcScan files may be
  11. installed in ArcScanII or ArcScanIII and updated in the same way,
  12. as described below.
  13.  
  14.  
  15. 1. Organisation of ARCSCAN II & III
  16.  
  17. ARCSCAN II  & III provide for two types of files:
  18.  
  19. Type 0     Magazine Files  -  With regular Volume and Issue numbers
  20. Type 1     Others
  21.  
  22. The files are held within Directories, and a !Custom file tells ARCSCAN
  23. what files to offer in its menu display, where to find them, and how to
  24. display  the  information  contained  in them. To add new sets of data to
  25. ARCSCAN, the appropriate directories must be created to contain the data,
  26. and the !Custom file must be extended to specify them.
  27.  
  28. Once this has been done, files may be updated/extended, or further files
  29. may be added to any existing DIRECTORIES. Provided they conform to the
  30. format prescribed in the !Custom file, no further changes to the
  31. latter will be needed.
  32.  
  33.  
  34. 2. Data on this Disc
  35.  
  36. The ARCHIVE data on this disc includes three sets of files:
  37.  
  38.    ARCHIVE Magazine contents    -  Type 0
  39.                                 -  Directory 'Archive'
  40.                                 -  Files     ARvol01  (Vol1, 1-12)
  41.                                              ARvol02  (Vol2, 1-12)
  42.                                              ARvol03  (Vol3, 1-12)
  43.                                              ARvol04  (Vol4, 1-12)
  44.                                              ARvol05  (Vol5, 1-3)
  45.    ARCHIVE Monthly Discs        -  Type 0
  46.                                 -  Directory 'ArDiscs'
  47.                                 -  Files     Advol01  (Vol1, 1-12)
  48.                                              Advol02  (Vol2, 1-12)
  49.                                              Advol03  (Vol3, 1-12)
  50.                                              Advol04  (Vol4, 1-12)
  51.                                              Advol05  (Vol5, 1-3)
  52.    ARCHIVE Care/Shareware Discs -  Type 1
  53.                                 -  Directory 'ShareCare'
  54.                                 -  Files     Careware   (Nos 1-16)
  55.                                              Shareware  (Nos 0-43)
  56.                                              WIMPed     (1 disc)
  57.  
  58. To add any of these to your ARCSCAN disc, or to update it, it is necessary
  59. only to make any appropriate changes to the !Custom file (see below), and
  60. then to copy the relevant DIRECTORY, along with its files, replacing any
  61. existing directories bearing the same names.
  62.  
  63.  
  64. 3. The !Custom File
  65.  
  66.  
  67.   3.1 The Length parameter
  68.  
  69. The !Custom file provides for specifying the maximum length of each entry
  70. in a file, and this is used to organise the 'paging' of the ARCSCAN
  71. display. For the Type 0 files above, the length is set to 6, so that
  72. several entries appear on each 'page' of the display. For the Type 1 file
  73. above, the length is set to 25 (the maximum allowed), so that the display
  74. shows one disc at a time. Setting this parameter wrongly, or exceeding the
  75. specified length for an entry, may result in parts of a record scrolling
  76. off the ARCSCAN display before they can be read.
  77.  
  78.  
  79.   3.2 Modifying the !Custom file
  80.  
  81.          **** BACKUP your ARCSCAN Disc before proceeding! ****
  82.  
  83. To modify your !Custom file, get !Edit installed on the DeskTop Icon Bar.
  84. Insert your ARCSCAN disc, and open a filer window. HOLDING DOWN SHIFT,
  85. double-click on !ArcScan to open a sub-window, which should contain the
  86. !Custom file. Drag this to !Edit. The latter should open a window
  87. displaying the file contents. Click MEN (centre button) on this window,
  88. and select Edit -> CR-LF, which should make the file readable.
  89.  
  90. Go to the foot of the list, using the scroll bars, and examine the last
  91. block of entries - it will start with '#' plus a number. NOTE THIS NUMBER
  92. - your entry will be the next number. At the end of the file you should
  93. find '##'. Position the cursor (SELect on the mouse pointer) to the
  94. immediate LEFT of this entry, and press RETURN. This should insert a blank
  95. line before the '##' file terminator. Move the cursor up to the start of
  96. it.
  97.  
  98. You now have to key in the entries for your new data. The formats are
  99. shown below for each of the three data sets. You may choose to enter just
  100. one, two or all three, but each entry must be matched by later creating
  101. the appropriate directory, else ARCSCAN is liable to have a nervous
  102. breakdown!
  103.  
  104.  
  105.   3.3 New Entries in !Custom file
  106.  
  107. The tables below show the entries for each of the three data sets. The
  108. parameter shown as <n> is to be replaced by the next entry number (without
  109. the '< >' ). The tabulated entries should be inserted between the last
  110. existing entry and the end-of-file marker '##', with no blank lines,
  111. extra spaces or other characters. NB no RETURN after the last item in the
  112. list!
  113.  
  114.  
  115.                       ***SPECIAL NOTE***
  116.  
  117. If you have already entered the 'ShareCare' directory and data from
  118. earlier discs, please check your !Custom file complies with the form given
  119. below, as the LENGTH parameter has had to be altered to accommodate the
  120. larger number of items on some later discs.
  121.  
  122.  
  123. ARCHIVE Magazine             Monthly Discs            Share/Careware Discs
  124. ----------------             -------------            --------------------
  125.  
  126. #<n>                         #<n>                     #<n>
  127. Archive                      ArDiscs                  ShareCare
  128. Archive                      ArDiscs                  ShareCare
  129. Archive                      ArDiscs                  Sharecare
  130. ARvol                        Advol                    *
  131. 0                            0                        1
  132. 6                            6                        25
  133.  
  134.   
  135.   3.4 Saving the Amended !Custom File
  136.  
  137. Now again select Edit -> CR-LF by the MEN button, to compact the data.
  138. Click MEN on your !ArcScan sub-window, select 'File !Custom -> ' and then
  139. the delete option to remove the old file. Click MEN on the !Edit window
  140. and select SAVE which will open a save box and an Icon. Check that the box
  141. still shows the filename as ....!Custom, and drag the Icon to your
  142. !ArcScan sub-window.
  143.  
  144.  
  145. 4. Loading Data Files
  146.  
  147. This is merely a matter of copying from this disc into your !ArcScan
  148. sub-window those directories that you have specified in the !Custom file.
  149. If you have earlier directories bearing the same names, these should first
  150. be deleted as described in section 3.4 for the !Custom file.
  151.  
  152. The copying may be done by leaving the DeskTop and using *COPY with the
  153. appropriate pathnames (and Option 'P' to prompt disc changes if you have
  154. only a single floppy drive).
  155.  
  156. The easier way however is to stay in the DeskTop and create (temporarily)
  157. a RAM Disk. Click MEN on the 'A' icon at the right of the icon bar. and
  158. select 'Task display'. A window will open showing memory allocations.
  159. Scroll down until you can see 'RAM disc'. Click SEL to the right of this
  160. and drag a red bar out to give, say, 256 K of RAM disk. Open the RAM disk
  161. filer by clicking on the icon that should now be visible at the left of
  162. the icon bar.
  163.  
  164. Now insert this disk and open the filer window containing the directories
  165. you want.  Drag the required directory to the RAM Disk window (it will
  166. carry all the contained files with it). 
  167. Re-insert your ARCSCAN disk and re-open the !ArcScan sub-window (remember
  168. to hold down SHIFT!).
  169. Drag the directory from the RAM disc window back into it.
  170.  
  171. You should now be in business, and double clicking on the !Arcscan icon in
  172. the MAIN ARCSCAN window should start ARCSCAN up. Selecting 'New Data'
  173. should reveal your new directory added to the list, and the right-hand
  174. window should confirm the files actually loaded.
  175.  
  176.                          ----- o -----
  177.